<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8" />
  <title>Library::Class class | My Project</title>
  <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
  <link rel="stylesheet" href="m-dark+documentation.compiled.css" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
</head>
<body>
<header><nav id="navigation">
  <div class="m-container">
    <div class="m-row">
      <a href="index.html" id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m">My Project</a>
      <div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
        <a id="m-navbar-show" href="#navigation" title="Show navigation"></a>
        <a id="m-navbar-hide" href="#" title="Hide navigation"></a>
      </div>
      <div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
        <div class="m-row">
          <ol class="m-col-t-6 m-col-m-none">
          </ol>
          <ol class="m-col-t-6 m-col-m-none" start="1">
            <li><a href="files.html">Files</a></li>
          </ol>
        </div>
      </div>
    </div>
  </div>
</nav></header>
<main><article>
  <div class="m-container m-container-inflatable">
    <div class="m-row">
      <div class="m-col-l-10 m-push-l-1">
        <h1>
          <span class="m-breadcrumb"><a href="namespaceLibrary.html">Library</a>::<wbr/></span>Class <span class="m-thin">class</span>
          <div class="m-doc-include m-code m-inverted m-text-right"><span class="cp">#include</span> <a class="cpf" href="Data_8h.html">&lt;Library/Data.h&gt;</a></div>
        </h1>
        <p>A class with overriden header file and name.</p>
        <nav class="m-block m-default">
          <h3>Contents</h3>
          <ul>
            <li>
              Reference
              <ul>
                <li><a href="#pub-methods">Public functions</a></li>
                <li><a href="#related">Related</a></li>
              </ul>
            </li>
          </ul>
        </nav>
<p>The overriden header <em>file</em> is used as the target location (where it links to the <code>Library.h</code> file, <em>not</em> to <code>Data.h</code> in which it&#x27;s defined), the header <em>name</em> is what gets displayed.</p>
        <section id="pub-methods">
          <h2><a href="#pub-methods">Public functions</a></h2>
          <dl class="m-doc">
            <dt>
              <span class="m-doc-wrap-bumper">void <a href="#af6424222f8f9bed68426d47cd0745f66" class="m-doc">foo</a>(</span><span class="m-doc-wrap">)</span>
            </dt>
            <dd>Class function.</dd>
          </dl>
        </section>
        <section id="related">
          <h2><a href="#related">Related</a></h2>
          <dl class="m-doc">
            <dt>
              <span class="m-doc-wrap-bumper">void <a href="#a9a4020432dcbac8c7e116306a28cc3d4" class="m-doc">related</a>(</span><span class="m-doc-wrap">)</span>
            </dt>
            <dd>A related function.</dd>
          </dl>
        </section>
        <section>
          <h2>Function documentation</h2>
          <section class="m-doc-details" id="af6424222f8f9bed68426d47cd0745f66"><div>
            <h3>
              <span class="m-doc-wrap-bumper">void Library::<wbr />Class::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#af6424222f8f9bed68426d47cd0745f66" class="m-doc-self">foo</a>(</span><span class="m-doc-wrap">)</span></span>
            </h3>
            <p>Class function.</p>
<p>The class has the location overriden to <code>Library.h</code> and thus location for the function (which is in <code>Data.h</code> and can&#x27;t be overriden) doesn&#x27;t match the class. Showing a different include for it won&#x27;t make sense tho as it&#x27;s a member, so the code pretends the current include matches the actual location and not what was overriden.</p>
          </div></section>
          <section class="m-doc-details" id="a9a4020432dcbac8c7e116306a28cc3d4"><div>
            <h3>
              <span class="m-doc-wrap-bumper">void </span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a9a4020432dcbac8c7e116306a28cc3d4" class="m-doc-self">related</a>(</span><span class="m-doc-wrap">)</span></span>
              <div class="m-doc-include m-code m-inverted m-text-right"><span class="cp">#include</span> <a class="cpf" href="Library_8h.html">&lt;Library/Library.h&gt;</a></div>
            </h3>
            <p>A related function.</p>
<p>This function is related to the class, but is in a different header, so it should have <code>#include &lt;Library/Library.h&gt;</code> even though the class has overriden the header file (but not name) to point to <code>Library.h</code>. The code still treats <code>Data.h</code> as the actual class definiton because otherwise all class members would list redundant <code>#include</code> in its detailed docs.</p>
          </div></section>
        </section>
      </div>
    </div>
  </div>
</article></main>
</body>
</html>
